From: Doug Goldstein <cardoe@cardoe.com>
Date: Sun, 18 Feb 2018 04:41:32 +0000 (-0600)
Subject: update contributing to show how to build the docs
X-Git-Tag: archive/raspbian/0.35.0-2+rpi1~3^2^2^2^2^2^2^2~22^2~2^2~91^2
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/success//%22http:/www.example.com/cgi/success/?a=commitdiff_plain;h=e59171aab00e6fb939a9fcbdcabacae27492d32c;p=cargo.git

update contributing to show how to build the docs

The contributing guide referenced a script that was deleted in
1271bb4de0c0 so it wasn't possible to follow the contributing guide
successfully prior to contributing doc improvements.
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index eb7374ee6..ed260e51a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -109,13 +109,16 @@ and [merges][mergequeue] it into Cargo's `master` branch.
 
 To contribute to the documentation, all you need to do is change the markdown
 files in the `src/doc` directory. To view the rendered version of changes you
-have made locally, run:
+have made locally, make sure you have `mdbook` installed and run:
 
 ```sh
-sh src/ci/dox.sh
-open target/doc/index.html
+cd src/doc
+mdbook build
+open book/index.html
 ```
 
+To install `mdbook` run `cargo install mdbook`.
+
 
 ## Issue Triage